Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without stress π
npm install --save styled-components
Utilising tagged template literals (a recent addition to JavaScript) and the power of CSS, styled-components
allows you to write actual CSS code to style your components. It also removes the mapping between components and styles β using components as a low-level styling construct could not be easier!
styled-components
is compatible with both React (for web) and ReactNative β meaning it's the perfect choice even for truly universal apps! See the ReactNative section for more information
Note: If you're not using npm
as your package manager, aren't using a module bundler or aren't sure about either of those jump to Alternative Installation Methods.
Made by Glen Maddern and Max Stoiber, supported by Front End Center and Thinkmill. Thank you for making this project possible!
Usage
Basic
This creates two react components, <Title>
and <Wrapper>
:
import React from 'react';
import styled from 'styled-components';
const Title = styled.h1`
font-size: 1.5em;
text-align: center;
color: palevioletred;
`;
const Wrapper = styled.section`
padding: 4em;
background: papayawhip;
`;
(The CSS rules are automatically vendor prefixed, so you don't have to think about it!)
You render them like so:
<Wrapper>
<Title>Hello World, this is my first styled component!</Title>
</Wrapper>
Passed props
Styled components pass on all their props. This is a styled <input>
:
import React from 'react';
import styled from 'styled-components';
const Input = styled.input`
font-size: 1.25em;
padding: 0.5em;
margin: 0.5em;
color: palevioletred;
background: papayawhip;
border: none;
border-radius: 3px;
&:hover {
box-shadow: inset 1px 1px 2px rgba(0,0,0,0.1);
}
`;
You can just pass a placeholder
prop into the styled-component
. It will pass it on to the DOM node like any other react component:
<Input placeholder="@mxstbr" type="text" />
Here is one input without any content showing the placeholder, and one with some content:
Adapting based on props
This is a button component that has a primary
state. By setting primary
to true
when rendering it we adjust the background and text color. (see tips and tricks for more examples of this pattern!)
import styled from 'styled-components';
const Button = styled.button`
/* Adapt the colors based on primary prop */
background: ${props => props.primary ? 'palevioletred' : 'white'};
color: ${props => props.primary ? 'white' : 'palevioletred'};
font-size: 1em;
margin: 1em;
padding: 0.25em 1em;
border: 2px solid palevioletred;
border-radius: 3px;
`;
export default Button;
<Button>Normal</Button>
<Button primary>Primary</Button>
Overriding component styles
Taking the Button
component from above and removing the primary rules, this is what we're left with β just a normal button:
import styled from 'styled-components';
const Button = styled.button`
background: white;
color: palevioletred;
font-size: 1em;
margin: 1em;
padding: 0.25em 1em;
border: 2px solid palevioletred;
border-radius: 3px;
`;
export default Button;
Let's say someplace else you want to use your button component, but just in this one case you want the color and border color to be tomato
instead of palevioletred
. Now you could pass in an interpolated function and change them based on some props, but that's quite a lot of effort for overriding the styles once.
To do this in an easier way you can call styled
as a function and pass in the previous component. You style that like any other styled-component. It overrides duplicate styles from the initial component and keeps the others around:
import React from 'react';
import styled from 'styled-components';
import Button from './Button';
const TomatoButton = styled(Button)`
color: tomato;
border-color: tomato;
`;
export default TomatoButton;
This is what our TomatoButton
looks like, even though we have only specified the color
and the border-color
. Instead of copy and pasting or factoring out the styles into a separate function we've now reused them.
Note: You can also pass tag names into the styled()
call, like so: styled('div')
. In fact, the styled.tagname helpers are just aliases of styled('tagname')
!
Third-party components
The above also works perfectly for styling third-party components, like a react-router
<Link />
!
import styled from 'styled-components';
import { Link } from 'react-router';
const StyledLink = styled(Link)`
color: palevioletred;
display: block;
margin: 0.5em 0;
font-family: Helvetica, Arial, sans-serif;
&:hover {
text-decoration: underline;
}
`;
<Link to="/">Standard, unstyled Link</Link>
<StyledLink to="/">This Link is styled!</StyledLink>
Note: styled-components
generate a real stylesheet with classes. The class names are then passed to the react component (including third party components) via the className
prop. For the styles to be applied, third-party components must attach the passed-in className
prop to a DOM node. Likewise, third-party react native components must attach the passed in style
prop. See Using styled-components
with existing CSS for more information!
Animations
CSS animations with @keyframes
aren't scoped to a single component but you still don't want them to be global. This is why we export a keyframes
helper which will generate a unique name for your keyframes. You can then use that unique name throughout your app.
This way, you get all the benefits of using JavaScript, are avoiding name clashes and get your keyframes like always:
import styled, { keyframes } from 'styled-components';
const rotate360 = keyframes`
from {
transform: rotate(0deg);
}
to {
transform: rotate(360deg);
}
`;
const Rotate = styled.div`
display: inline-block;
animation: ${rotate360} 2s linear infinite;
`;
This will now rotate it's children over and over again, for example our logo:
<Rotate>< π
></Rotate>
React Native
styled-components
has a ReactNative mode that works exactly the same, except you import the things from styled-components/native
:
import styled from 'styled-components/native';
const StyledView = styled.View`
background-color: papayawhip;
`;
const StyledText = styled.Text`
color: palevioletred;
`;
class MyReactNativeComponent extends React.Component {
render() {
return (
<StyledView>
<StyledText>Hello World!</StyledText>
</StyledView>
)
}
}
We also support more complex styles (like transform
), which would normally be an array, and shorthands (e.g. for margin
) thanks to css-to-react-native
! Imagine how you'd write the property in ReactNative, guess how you'd transfer it to CSS and you're probably right:
const RotatedBox = styled.View`
transform: rotate(90deg);
text-shadow-offset: 10 5;
font-variant: small-caps;
margin: 5 7 2;
`
You cannot use the keyframes
and injectGlobal
helpers since ReactNative doesn't support keyframes or global styles. We will also log a warning if you use media queries or nesting in your CSS.
Theming
styled-components
has full theming support by exporting a wrapper <ThemeProvider>
component. This component provides a theme to all react components underneath itself in the render tree, even multiple levels deep.
To illustrate this, let's create a component that renders its children with a theme. We do so by wrapping all its children in a ThemeProvider
that has a theme
:
import { ThemeProvider } from 'styled-components';
const theme = {
main: 'mediumseagreen',
};
const GreenSection = (props) => {
return (
<ThemeProvider theme={theme}>
{props.children}
</ThemeProvider>
);
}
Second, let's create a styled component that adapts to the theme.
styled-components
injects the current theme via props.theme
into the components, which means you can adapt your component to the theme with interpolated functions.
We'll create a button
that adapts based on the main
property of the theme:
import styled from 'styled-components';
const Button = styled.button`
/* Color the background and border with theme.main */
background: ${props => props.theme.main};
border: 2px solid ${props => props.theme.main};
/* β¦more styles hereβ¦ */
`;
Now, when we render the Button
inside a GreenSection
, it'll be green!
<GreenSection>
<div>
{/* Notice how there's no code changes for the button, it just
adapts to the theme passed from GreenSection! */}
<Button>Green Button!</Button>
<div>
<div>
{/* This works unlimited levels deep within the component
tree since we use React's context to pass the theme down. */}
<Button>Another green button!</Button>
</div>
</div>
</div>
</GreenSection>
See the theming doc for more detailed instructions.
Note: Please make sure you sanitize user input if you accept custom themes from users! See the security doc for more information.
Defaults
The problem with the above code is that if the button is rendered outside a ThemeProvider
, it won't have any background or border!
There is an easy remedy though. Since Button
is just a react component we can assign defaultProps
, which will be used if no theme is provided:
import styled from 'styled-components';
const Button = styled.button`
/* Color the background and border with theme.main */
background: ${props => props.theme.main};
border: 2px solid ${props => props.theme.main};
/* β¦more styles hereβ¦ */
`;
Button.defaultProps = {
theme: {
main: 'palevioletred',
},
};
Docs
See the documentation for more information about using styled-components
.
Table of Contents
Linting
There is (currently experimental) support for stylelint
β meaning you can take advantage of 150 rules to make sure your styled-components
CSS is solid!
See the stylelint-processor-styled-components
repository for installation instructions.
Syntax highlighting
The one thing you lose when writing CSS in template literals is syntax highlighting. We're working hard on making proper syntax highlighting happening in all editors. We currently have support for Atom, Visual Studio Code, and soon Sublime Text.
This is what it looks like when properly highlighted:
Atom
@gandm, the creator of language-babel
, has added support for styled-components
in Atom!
To get proper syntax highlighting, all you have to do is install and use the language-babel
package for your JavaScript files!
Sublime Text
There is an open PR by @garetmckinley to add support for styled-components
to babel-sublime
! (if you want the PR to land, feel free to π the initial comment to let the maintainers know there's a need for this!)
As soon as that PR is merged and a new version released, all you'll have to do is install and use babel-sublime
to highlight your JavaScript files!
Visual Studio Code
The vscode-styled-components extension provides syntax highlighting inside your Javascript files. You can install it as usual from the Marketplace.
VIM / NeoVim
The vim-styled-components
plugin gives you syntax highlighting inside your Javascript files. Install it with your usual plugin manager like Plug, Vundle, Pathogen, etc.
Also if you're looking for an awesome javascript syntax package you can never go wrong with YAJS.vim.
Other Editors
We could use your help to get syntax highlighting support to other editors! If you want to start working on syntax highlighting for your editor, open an issue to let us know.
Built with styled-components
Libraries
Grid Systems
Helpers
Boilerplates
Websites
Other
Built something with styled-components
? Submit a PR and add it to this list!
Further Reading
These are some great articles and talks about related topics in case you're hungry for more:
Alternative Installation Methods
If you're not using a module bundler or not using npm
as your package manager, we also have a global ("UMD") build!
You can use that via the unpkg
CDN to get styled-components
, the URL is https://unpkg.com/styled-components/dist/styled-components.min.js
.
To install styled-components
with bower you'd do:
bower install styled-components=https://unpkg.com/styled-components/dist/styled-components.min.js
To use it from your HTML, add this at the bottom of your index.html
, and you'll have access to the global window.styled
variable:
<script src="https://unpkg.com/styled-components/dist/styled-components.min.js" type="text/javascript"></script>
Other solutions
If styled-components
isn't quite what you're looking for, maybe something in this list is:
glamorous
- basically styled-components
but using JS objects and functions instead of strings.
License
Licensed under the MIT License, Copyright Β© 2016 Glen Maddern and Maximilian Stoiber.
See LICENSE for more information.
Acknowledgements
This project builds on a long line of earlier work by clever folks all around the world. We'd like to thank Charlie Somerville, Nik Graf, Sunil Pai, Michael Chan, Andrey Popp, Jed Watson & Andrey Sitnik who contributed ideas, code or inspiration.
Special thanks to @okonet for the fantastic logo.